refactor dialog-helper to use toggle events#3332
Closed
Conversation
🦋 Changeset detectedLatest commit: 952e020 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
524a0b9 to
df09d94
Compare
Contributor
|
Hi! This pull request has been marked as stale because it has been open with no activity for 60 days. You can comment on the pull request or remove the stale label to keep it open. If you do nothing, this pull request will be closed in 7 days. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Authors: Please fill out this form carefully and completely.
Reviewers: By approving this Pull Request you are approving the code change, as well as its deployment and mitigation plans.
Please read this description carefully. If you feel there is anything unclear or missing, please ask for updates.
What are you trying to accomplish?
In #3144 we managed to reduce the cost of an expensive recalc by using
@property --dialog-scrollgutter { inherits: false }. This dramatically reduced the recalc cost of this particular bit of code.However one thing we wanted to do - but failed to achieve in that PR - was to perform this calc as late as possible. Right now every page load (or thereabouts) that features a dialog causes this recalc. In #3144 we first tried to override the invoker function to do this during the click of the opener button, however there are callsites in the monolith that don't use the opener button, and instead call
showModaldirectly. We could have overridden that but it was deemed a risky change. This was discussed here: #3144 (comment). In this discussion I pointed out that once whatwg/html#9733 lands then we could usebeforetoggleto reliably find a point in time just before the dialog opens, but this is a more complex fix.So, fast forward to today;
beforetoggleandtoggleexist in Chrome & Firefox, and have recently been merged in Safari. I have a polyfill available to support browsers which don't support these events, which works reliably.So this PR refactors the dialog helper to use
beforetoggleto set the--dialog-scrollgutter. It brings in the polyfill to ensure cross-browser-compat.Additionally, our dialog-helper code uses a MutationObserver to force dialogs to be shown as modal, not as non-modal. This takes the opportunity to use the
toggleevent to do this instead. This will have a far smaller impact on performance than the change usingbeforetoggle, but it certainly helps and makes the code cleaner & more readable.Screenshots
Integration
List the issues that this change affects.
Risk Assessment
What approach did you choose and why?
Anything you want to highlight for special attention from reviewers?
Accessibility
Merge checklist
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.